Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the referenced Warehouse.

Query Parameters

fields
enum<string>[]

Specify additional fields of the LocationProfile object to be included in the response.

Available options:
all,
name,
description,
status,
member_count,
match,
match_readable,
location_tags,
slot_types,
active_revision,
pending_revision,
used_by,
created_at,
updated_at
fields:location_tags
enum<string>[]

Specify fields of the directly referenced LocationTag objects to include under included.LocationTag. Add location_tags to the root fields parameter to return the relationship. type and id are always returned. Specify additional fields of the LocationTag object to be included in the response.

Available options:
basic,
all,
name,
description,
color,
sort_order,
is_deleted,
created_at,
updated_at
fields:slot_types
enum<string>[]

Specify fields of the directly referenced SlotType objects to include under included.SlotType. Add slot_types to the root fields parameter to return the relationship. type and id are always returned. Specify additional fields of the SlotType object to be included in the response.

Available options:
basic,
all,
name,
is_pickable,
sort_order,
patterns,
is_fixed_capacity,
slot_dimensions,
weight_capacity,
created_at,
updated_at
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • name
  • status

status is derived from the profile's revision pointers rather than stored, so it supports only the eq and in operators. List the states you want instead of negating.

sort
string

The default sort order is ascending by primary key (sort=id). The following fields are available for sorting:

  • id
  • name
  • member_count
  • updated_at

A profile with no published revision has a null member count rather than zero, so sorting by member_count groups those profiles at the null end — first ascending, last descending.

count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

limit
integer
default:100

The number of LocationProfile objects to return. The default is 100 and the maximum is 250.

Required range: 1 <= x <= 250
Example:

100

Response

A dictionary with a collection property that contains a list of up to limit LocationProfile objects matching the query.

collection
LocationProfile · object[]

A list of LocationProfile objects.

included
object

Direct Location Tags and Slot Types expanded through nested fields:* parameters.

Example:
has_more
boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

next
string | null

The resource path for the next page of results if any are expected.

previous
string | null

The resource path for the previous page of results if any are expected.

meta
object

Warehouse-level membership repair freshness. This is the freshness of the authoritative resolved membership, distinct from the Replenishment quantity computation freshness.